STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

D.20.1 StructureDefinition: DAF-SmokingStatus

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/daf-smokingstatus

Smoking Status Observation

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by Health Level Seven International (Infrastructure and Messaging - Data Access Framework).

D.20.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationSmoking Status Observation
... identifier S0..*Identifier
... status S1..1code
... code S1..1CodeableConceptSmoking Status: LOINC 72166-2 = Tobacco smoking status NHIS
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]}
... subject S0..1Reference(DAF-Patient)
... encounter S0..1Reference(DAF-Encounter)
... effectivePeriod S0..1dateTime, Period
... issued S0..1instant
... performer S0..*Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)
... valueCodeableConcept S0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodCoded Responses from Smoking Status Value Set
Binding: Smoking Status (required)
... interpretation 0..0
... bodySite 0..0
... method 0..0
... referenceRange 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationSmoking Status Observation
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptSmoking Status: LOINC 72166-2 = Tobacco smoking status NHIS
Binding: LOINC Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]}
... subject S ∑0..1Reference(DAF-Patient)Who and/or what this is about
... encounter S0..1Reference(DAF-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued S ∑0..1instantDate/Time this was made available
... performer S ∑0..*Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)Who is responsible for the observation
... value[x] S ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodCoded Responses from Smoking Status Value Set
Binding: Smoking Status (required)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... comment 0..1stringComments about result
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... related ∑0..*BackboneElementResource related to this observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*ObservationSmoking Status Observation
... identifier S0..*Identifier
... status S1..1code
... code S1..1CodeableConceptSmoking Status: LOINC 72166-2 = Tobacco smoking status NHIS
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]}
... subject S0..1Reference(DAF-Patient)
... encounter S0..1Reference(DAF-Encounter)
... effectivePeriod S0..1dateTime, Period
... issued S0..1instant
... performer S0..*Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)
... valueCodeableConcept S0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodCoded Responses from Smoking Status Value Set
Binding: Smoking Status (required)
... interpretation 0..0
... bodySite 0..0
... method 0..0
... referenceRange 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationSmoking Status Observation
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierUnique Id for this particular observation
... status ?! S∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptSmoking Status: LOINC 72166-2 = Tobacco smoking status NHIS
Binding: LOINC Codes (example)
Required Pattern: {"coding":[{"system":"http://loinc.org","code":"72166-2"}]}
... subject S ∑0..1Reference(DAF-Patient)Who and/or what this is about
... encounter S0..1Reference(DAF-Encounter)Healthcare event during which this observation is made
... effective[x] S ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued S ∑0..1instantDate/Time this was made available
... performer S ∑0..*Reference(DAF-Pract | DAF-Patient | DAF-RelatedPerson | DAF-Organization)Who is responsible for the observation
... value[x] S ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodCoded Responses from Smoking Status Value Set
Binding: Smoking Status (required)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... comment 0..1stringComments about result
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... related ∑0..*BackboneElementResource related to this observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

D.20.1.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeLOINC CodesexampleLOINC Codes
Observation.value[x]Smoking StatusrequiredSmoking Status
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

D.20.1.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
.